<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Priithon.plt.plot_objects.legend_object</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Priithon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/priithon">Priithon</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="Priithon-module.html">Package&nbsp;Priithon</a> ::
        <a href="Priithon.plt-module.html">Package&nbsp;plt</a> ::
        <a href="Priithon.plt.plot_objects-module.html">Module&nbsp;plot_objects</a> ::
        Class&nbsp;legend_object
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="Priithon.plt.plot_objects.legend_object-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class legend_object</h1><p class="nomargin-top"><span class="codelink"><a href="Priithon.plt.plot_objects-pysrc.html#legend_object">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_priithon_26" name="uml_class_diagram_for_priithon_26">
<area shape="rect" id="node99" href="Priithon.plt.plot_objects.legend_object-class.html#__init__" title="Priithon.plt.plot_objects.legend_object.__init__" alt="" coords="81,377,321,396"/>
<area shape="rect" id="node99" href="Priithon.plt.plot_objects.legend_object-class.html#layout" title="Priithon.plt.plot_objects.legend_object.layout" alt="" coords="81,396,321,415"/>
<area shape="rect" id="node99" href="Priithon.plt.plot_objects.legend_object-class.html#draw" title="Priithon.plt.plot_objects.legend_object.draw" alt="" coords="81,415,321,433"/>
<area shape="rect" id="node1" href="Priithon.plt.plot_objects.legend_object-class.html" title="Draws a legend to the lines plotted on the graph." alt="" coords="69,345,333,439"/>
<area shape="rect" id="node100" href="Priithon.plt.plot_utility.property_object-class.html#clone_properties" title="Reset the objects attributes to their default values." alt="" coords="17,160,185,179"/>
<area shape="rect" id="node100" href="Priithon.plt.plot_utility.property_object-class.html#reset_default" title="Reset the objects attributes to their default values." alt="" coords="17,179,185,197"/>
<area shape="rect" id="node2" href="Priithon.plt.plot_utility.property_object-class.html" title="Base class for graph object with properties like &#39;color&#39;, &#39;font&#39;, etc." alt="" coords="5,127,197,203"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#left" title="Return the x&#45;coordinate of the left edge." alt="" coords="239,39,367,57"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#right" title="Return the x&#45;coordinate of the right edge." alt="" coords="239,57,367,76"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#top" title="Return the y&#45;coordinate of the top edge." alt="" coords="239,76,367,95"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#bottom" title="Return the y&#45;coordinate of the bottom edge." alt="" coords="239,95,367,113"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#center_x" title="Return the x&#45;coordinate of the boxes center." alt="" coords="239,113,367,132"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#center_y" title="Return the y&#45;coordinate of the left edge." alt="" coords="239,132,367,151"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#size" title="Return the size of the box as array((width,height))." alt="" coords="239,151,367,169"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#width" title="Return the width of the box (length along x&#45;axis)" alt="" coords="239,169,367,188"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#height" title="Return the width of the box (length along y&#45;axis)" alt="" coords="239,188,367,207"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#center" title="Return the coordinates of the boxes center as an array" alt="" coords="239,207,367,225"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#radial" title="Length of a ray extending from the center of the box at the specified polar angle (in radians) to the edge of the box" alt="" coords="239,225,367,244"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#move" title="Move box so that its top left corner is located at the specified location." alt="" coords="239,244,367,263"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#translate" title="Shift the box&#39;s location by the amount specifed in offset." alt="" coords="239,263,367,281"/>
<area shape="rect" id="node101" href="Priithon.plt.plot_utility.box_object-class.html#contains" title="Priithon.plt.plot_utility.box_object.contains" alt="" coords="239,300,367,319"/>
<area shape="rect" id="node3" href="Priithon.plt.plot_utility.box_object-class.html" title="Helpful for laying out rectangles." alt="" coords="227,6,379,325"/>
</map>
  <img src="uml_class_diagram_for_priithon_26.gif" alt='' usemap="#uml_class_diagram_for_priithon_26" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Draws a legend to the lines plotted on the graph.</p>
  <p>Unimplemented.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Priithon.plt.plot_objects.legend_object-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">**attr</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Priithon.plt.plot_objects-pysrc.html#legend_object.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="layout"></a><span class="summary-sig-name">layout</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">graph_lines</span>,
        <span class="summary-sig-arg">graph_area</span>,
        <span class="summary-sig-arg">dc</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Priithon.plt.plot_objects-pysrc.html#legend_object.layout">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="draw"></a><span class="summary-sig-name">draw</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">dc</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Priithon.plt.plot_objects-pysrc.html#legend_object.draw">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Priithon.plt.plot_utility.property_object-class.html">plot_utility.property_object</a></code></b>:
      <code><a href="Priithon.plt.plot_utility.property_object-class.html#clone_properties">clone_properties</a></code>,
      <code><a href="Priithon.plt.plot_utility.property_object-class.html#reset_default">reset_default</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Priithon.plt.plot_utility.box_object-class.html">plot_utility.box_object</a></code></b>:
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#above">above</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#below">below</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#bottom">bottom</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#center">center</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#center_on">center_on</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#center_on_x_of">center_on_x_of</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#center_on_y_of">center_on_y_of</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#center_x">center_x</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#center_y">center_y</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#contains">contains</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#height">height</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#inflate">inflate</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#left">left</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#left_of">left_of</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#move">move</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#radial">radial</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#radial_offset_from">radial_offset_from</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#right">right</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#right_of">right_of</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#same_as">same_as</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#set_height">set_height</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#set_size">set_size</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#set_width">set_width</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#size">size</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#top">top</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#translate">translate</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#trim_all">trim_all</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#trim_bottom">trim_bottom</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#trim_left">trim_left</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#trim_right">trim_right</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#trim_top">trim_top</a></code>,
      <code><a href="Priithon.plt.plot_utility.box_object-class.html#width">width</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Priithon.plt.plot_objects.legend_object-class.html#_attributes" class="summary-name" onclick="show_private();">_attributes</a> = <code title="{'border': ['yes', ['yes', 'no'], 'Place border around legend'],
 'fill_color': ['white',
                ['black',
                 'blue',
                 'green',
                 'red',
                 'yellow',
                 'cyan',
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">border</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">yes</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">yes</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">no</code><code class="variable-quote">'</code><code class="variable-group">]</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Place border </code><code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">**attr</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Priithon.plt.plot_objects-pysrc.html#legend_object.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Overrides:
        <a href="Priithon.plt.plot_utility.box_object-class.html#__init__">plot_utility.box_object.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variable Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariableDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="_attributes"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">_attributes</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">border</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">yes</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">yes</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">no</code><code class="variable-quote">'</code><code class="variable-group">]</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">Place border around legend</code><code class="variable-quote">'</code><code class="variable-group">]</code><code class="variable-op">,</code>
 <code class="variable-quote">'</code><code class="variable-string">fill_color</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">white</code><code class="variable-quote">'</code><code class="variable-op">,</code>
                <code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">black</code><code class="variable-quote">'</code><code class="variable-op">,</code>
                 <code class="variable-quote">'</code><code class="variable-string">blue</code><code class="variable-quote">'</code><code class="variable-op">,</code>
                 <code class="variable-quote">'</code><code class="variable-string">green</code><code class="variable-quote">'</code><code class="variable-op">,</code>
                 <code class="variable-quote">'</code><code class="variable-string">red</code><code class="variable-quote">'</code><code class="variable-op">,</code>
                 <code class="variable-quote">'</code><code class="variable-string">yellow</code><code class="variable-quote">'</code><code class="variable-op">,</code>
                 <code class="variable-quote">'</code><code class="variable-string">cyan</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="Priithon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/priithon">Priithon</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Nov 22 14:59:37 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
